Associates an application-defined promise-keeper function with a scrap or removes an associated promise-keeper.

OSStatus SetScrapPromiseKeeper (
    ScrapRef scrap, 
    ScrapPromiseKeeperUPP upp, 
    const void *userData
);

Parameter descriptions

scrap

A reference to the scrap to set the promise-keeper function for.

upp

A universal procedure pointer to a function to set as the scrap promise-keeper function. For more information, see ScrapPromiseKeeperProcPtr

You can remove a promise-keeper function from a scrap by passing NULL for this parameter.

userData

An untyped pointer to a buffer, local variable, or other storage location, created and disposed of by your application. This value is passed to the promise-keeper function specified by upp, which can do whatever it needs to do with the value. For example, you might pass a pointer or handle to some private scrap data that your promise-keeper function uses in fabricating one or more promised flavors.

If your promise-keeper function has no need for special user data, pass NULL for this parameter.

function result

A result code.

AVAILABILITY

Supported in Carbon. Available in Carbon 1.0.2 and later when running Mac OS 8.1 or later.

© 2000 Apple Computer, Inc. (Last Updated 7/17/2000)